Skip to content

Generate comprehensive README in .bumpy/ during init#29

Merged
theoephraim merged 3 commits into
mainfrom
feat/init-readme
Apr 21, 2026
Merged

Generate comprehensive README in .bumpy/ during init#29
theoephraim merged 3 commits into
mainfrom
feat/init-readme

Conversation

@theoephraim

Copy link
Copy Markdown
Member

Summary

  • bumpy init now generates a detailed README.md in the .bumpy/ directory explaining what bumpy is, how bump files work, and all the ways to create them (interactive, non-interactive, by hand, conventional commits, empty)
  • Commands in the README are auto-tailored to the detected package manager (npx/bunx/pnpm/yarn)
  • The README template lives in the repo's own .bumpy/README.md (dogfooding) and is inlined at build time via tsdown's text loader

Test plan

  • Run bumpy init in a fresh project with different package managers and verify the README uses the correct runner command
  • Verify the build still succeeds and the README content is inlined in the bundle

🤖 Generated with Claude Code

@bumpy-bot

bumpy-bot commented Apr 21, 2026

Copy link
Copy Markdown
Collaborator

bumpy-frog

The changes in this PR will be included in the next version bump.

patch Patch releases

  • @varlock/bumpy 1.0.0 → 1.0.1

Bump files in this PR

Click here if you want to add another bump file to this PR


This comment is maintained by bumpy.

@theoephraim theoephraim force-pushed the feat/init-readme branch 2 times, most recently from 94fe27d to 8ceea74 Compare April 21, 2026 20:21
theoephraim and others added 2 commits April 21, 2026 15:04
The init command now generates a detailed README explaining what bumpy
is, how bump files work, and all the ways to create them (interactive,
non-interactive, by hand, from conventional commits, empty). Commands
are auto-detected to use the correct package manager runner (npx, bunx,
pnpm, yarn). The README template lives in the repo's own .bumpy/
directory and is inlined at build time via tsdown's text loader.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
No need for an env var / build-time injection — just hardcode
https://bumpy.varlock.dev everywhere. Removes the varlock env
definition, tsdown define, bunfig entry, and globals declaration.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@theoephraim theoephraim merged commit 5023650 into main Apr 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants